SetVServerGroupAttribute
Description
call SetVServerGroupAttribute to modify the configuration of the virtual server group.
Request Method
POST
Request Path
/apsara/route/Slb/SetVServerGroupAttribute
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
VServerGroupId | BODY | string | Yes | rsp-cige6**** | backend server group ID. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
VServerGroupName | BODY | string | No | vserver-group-test | virtual server group name. |
RegionId | BODY | string | Yes | cn-qingdao-env17-d01 | load balancing region ID. |
BackendServers | BODY | string | No | [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.XX.XX. 6", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.XX.XX. 6", "Port":"80","Description":"test-113" }] | virtual server group list. a single call can add up to 20 back-end servers. ServerId:String type, required, instance ID of backend server or ENI instance ID. Port:Integer type, required, port used by backend server, value range:1~65535. Weight:Integer type, required, weight of backend server, value range:0~100. Description :String type, optional, backend server description, 1-80 characters in length, allow letters, numbers, dashes (-), forward slashes (/), half-width periods (.), and underscores (_). Chinese is supported. Type:String type, indicating the instance type of the backend server, value: ecs(default):ECS instance. eni: ENI instance. ServerIp: the instance IP of ECS or ENI. The example is as follows: example of mounting ECS:[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port": "80", "Description": "test-112" }] mount ENI:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" }] mount ENI multi-IP:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port": "80", "Description": "test-113" }] |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
VServerGroupId | string | rsp-cige6**** | server group ID. |
Type | string | ecs | backend server type, value: ecs(default):ECS instance. eni: ENI instance. |
ServerId | string | i-bp1ek6yd7jvkx**** | ECS instance ID or ENI instance ID. |
Description | string | backend server group description. | backend server group description. |
RequestId | string | 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C | request ID. |
BackendServer | No sample value for this parameter. | No description for this parameter. | |
Port | integer | 70 | the port used by the backend server. |
VServerGroupName | string | Group1 | virtual server group name. |
BackendServers | array of backendserver | No sample value for this parameter. | backend server list. |
Weight | integer | 100 | the weight of the back-end server. |
Example
Successful Response example
{
"VServerGroupId":"rsp-cige6****",
"Type":"ecs",
"ServerId":"i-bp1ek6yd7jvkx****",
"Description":"backend server group description.",
"RequestId":"9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
"BackendServer":"",
"Port":"70",
"VServerGroupName":"Group1",
"BackendServers":"",
"Weight":"100"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}